<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Railway Operation Simulator: API.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="railway-logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Railway Operation Simulator
   &#160;<span id="projectnumber">v2.23.2</span>
   </div>
   <div id="projectbrief">A railway simulator for Windows</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_a_p_i_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">API.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="_a_p_i_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160; </div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="preprocessor">#ifndef APIH</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="preprocessor">#define APIH</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment">//---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160; </div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#include &quot;System.hpp&quot;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#include &quot;System.IniFiles.hpp&quot;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#include &quot;System.SysUtils.hpp&quot;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#include &quot;System.AnsiStrings.hpp&quot;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#include &quot;System.IOUtils.hpp&quot;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160; </div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#include &lt;map&gt;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor">#include &lt;algorithm&gt;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor">#include &lt;windows.h&gt;</span>            <span class="comment">//needed for 64 bit compilation</span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="class_a_p_i.html">   35</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_a_p_i.html">API</a></div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;{</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;     <span class="keyword">private</span>:</div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="class_a_p_i.html#ab8c8347a7be811af2f0c102c2eb3b236">   38</a></span>&#160;        AnsiString <a class="code" href="class_a_p_i.html#ab8c8347a7be811af2f0c102c2eb3b236">file_path_</a>;</div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="class_a_p_i.html#a77a81598cc3233ba0a21f98aa29889af">   39</a></span>&#160;        std::vector&lt;AnsiString&gt; <a class="code" href="class_a_p_i.html#a77a81598cc3233ba0a21f98aa29889af">reset_excludes_</a>;</div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="class_a_p_i.html#a4ea0e900d0f4bf06ba25587a034f8f4f">   40</a></span>&#160;        std::map&lt;AnsiString, AnsiString*&gt; <a class="code" href="class_a_p_i.html#a4ea0e900d0f4bf06ba25587a034f8f4f">metadata_str_</a>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="class_a_p_i.html#a398a165383bd7158830ee2f0a98e89a5">   41</a></span>&#160;        std::map&lt;AnsiString, bool*&gt; <a class="code" href="class_a_p_i.html#a398a165383bd7158830ee2f0a98e89a5">metadata_bool_</a>;</div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="class_a_p_i.html#adafb7d74cbe7709debfb54be4d482d4e">   42</a></span>&#160;        std::map&lt;AnsiString, int*&gt; <a class="code" href="class_a_p_i.html#adafb7d74cbe7709debfb54be4d482d4e">metadata_int_</a>;</div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="class_a_p_i.html#ade75f7ec04482591f5ec32e1348bfb86">   43</a></span>&#160;        std::map&lt;AnsiString, AnsiString&gt; <a class="code" href="class_a_p_i.html#ade75f7ec04482591f5ec32e1348bfb86">train_statuses_</a>;</div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;     <span class="keyword">public</span>:</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;        <a class="code" href="class_a_p_i.html#aea05113c3d6e4567708faedd0496a1e7">API</a>(<span class="keyword">const</span> AnsiString&amp; file_name);</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160; </div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_a_p_i.html#a3a2f4241ce0a02bea5b9c5bd4129382e">reset_all</a>();</div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160; </div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_a_p_i.html#a9709328b5821e6ae094c10770bc5a498">find_metadata_file</a>();</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160; </div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_a_p_i.html#ac531383de112e6ecfe732c72028f31df">add_metadata_str</a>(<span class="keyword">const</span> AnsiString&amp; label, AnsiString* data);</div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160; </div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_a_p_i.html#aeeef34d89b6e7cb0086e08ab136c43c7">add_metadata_bool</a>(<span class="keyword">const</span> AnsiString&amp; label, <span class="keywordtype">bool</span>* data);</div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160; </div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_a_p_i.html#a6d770c4a39e262a9a364a430ac7587f6">add_metadata_int</a>(<span class="keyword">const</span> AnsiString&amp; label, <span class="keywordtype">int</span>* data);</div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160; </div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_a_p_i.html#a24df4bf6f49e4f42353f4bd04268d4eb">write_string</a>(<span class="keyword">const</span> AnsiString&amp; label, <span class="keyword">const</span> AnsiString&amp; data);</div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160; </div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_a_p_i.html#ae4039467fe2652d5826f10224608cd56">write_int</a>(<span class="keyword">const</span> AnsiString&amp; label, <span class="keyword">const</span> <span class="keywordtype">int</span>&amp; data);</div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160; </div>
<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_a_p_i.html#a12de5384d7783f93cf7b3a19fa0d8e74">write_bool</a>(<span class="keyword">const</span> AnsiString&amp; label, <span class="keyword">const</span> <span class="keywordtype">bool</span>&amp; data);</div>
<div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160; </div>
<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="class_a_p_i.html#abebc08c03ceec2b898d8fe877b0efcba">dump</a>();</div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160; </div>
<div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;        <a class="code" href="class_a_p_i.html#a583ec65b542b44e4b7013f5fc830fdcd">~API</a>();</div>
<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;};</div>
<div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160; </div>
<div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclass_a_p_i_html_a398a165383bd7158830ee2f0a98e89a5"><div class="ttname"><a href="class_a_p_i.html#a398a165383bd7158830ee2f0a98e89a5">API::metadata_bool_</a></div><div class="ttdeci">std::map&lt; AnsiString, bool * &gt; metadata_bool_</div><div class="ttdef"><b>Definition:</b> <a href="_a_p_i_8h_source.html#l00041">API.h:41</a></div></div>
<div class="ttc" id="aclass_a_p_i_html_ae4039467fe2652d5826f10224608cd56"><div class="ttname"><a href="class_a_p_i.html#ae4039467fe2652d5826f10224608cd56">API::write_int</a></div><div class="ttdeci">void write_int(const AnsiString &amp;label, const int &amp;data)</div><div class="ttdoc">write an integer directly to the metadata</div><div class="ttdef"><b>Definition:</b> <a href="_a_p_i_8cpp_source.html#l00036">API.cpp:36</a></div></div>
<div class="ttc" id="aclass_a_p_i_html_a12de5384d7783f93cf7b3a19fa0d8e74"><div class="ttname"><a href="class_a_p_i.html#a12de5384d7783f93cf7b3a19fa0d8e74">API::write_bool</a></div><div class="ttdeci">void write_bool(const AnsiString &amp;label, const bool &amp;data)</div><div class="ttdoc">write a boolean directly to the metadata</div><div class="ttdef"><b>Definition:</b> <a href="_a_p_i_8cpp_source.html#l00040">API.cpp:40</a></div></div>
<div class="ttc" id="aclass_a_p_i_html_adafb7d74cbe7709debfb54be4d482d4e"><div class="ttname"><a href="class_a_p_i.html#adafb7d74cbe7709debfb54be4d482d4e">API::metadata_int_</a></div><div class="ttdeci">std::map&lt; AnsiString, int * &gt; metadata_int_</div><div class="ttdef"><b>Definition:</b> <a href="_a_p_i_8h_source.html#l00042">API.h:42</a></div></div>
<div class="ttc" id="aclass_a_p_i_html_a9709328b5821e6ae094c10770bc5a498"><div class="ttname"><a href="class_a_p_i.html#a9709328b5821e6ae094c10770bc5a498">API::find_metadata_file</a></div><div class="ttdeci">void find_metadata_file()</div><div class="ttdoc">tries to find a metadata file for the currently session</div><div class="ttdef"><b>Definition:</b> <a href="_a_p_i_8cpp_source.html#l00044">API.cpp:44</a></div></div>
<div class="ttc" id="aclass_a_p_i_html_a4ea0e900d0f4bf06ba25587a034f8f4f"><div class="ttname"><a href="class_a_p_i.html#a4ea0e900d0f4bf06ba25587a034f8f4f">API::metadata_str_</a></div><div class="ttdeci">std::map&lt; AnsiString, AnsiString * &gt; metadata_str_</div><div class="ttdef"><b>Definition:</b> <a href="_a_p_i_8h_source.html#l00040">API.h:40</a></div></div>
<div class="ttc" id="aclass_a_p_i_html_a583ec65b542b44e4b7013f5fc830fdcd"><div class="ttname"><a href="class_a_p_i.html#a583ec65b542b44e4b7013f5fc830fdcd">API::~API</a></div><div class="ttdeci">~API()</div><div class="ttdoc">destructor which clears INI file when program is terminated</div><div class="ttdef"><b>Definition:</b> <a href="_a_p_i_8cpp_source.html#l00154">API.cpp:154</a></div></div>
<div class="ttc" id="aclass_a_p_i_html_aea05113c3d6e4567708faedd0496a1e7"><div class="ttname"><a href="class_a_p_i.html#aea05113c3d6e4567708faedd0496a1e7">API::API</a></div><div class="ttdeci">API(const AnsiString &amp;file_name)</div><div class="ttdoc">construct an API object using creating the given INI file</div><div class="ttdef"><b>Definition:</b> <a href="_a_p_i_8cpp_source.html#l00012">API.cpp:12</a></div></div>
<div class="ttc" id="aclass_a_p_i_html_a24df4bf6f49e4f42353f4bd04268d4eb"><div class="ttname"><a href="class_a_p_i.html#a24df4bf6f49e4f42353f4bd04268d4eb">API::write_string</a></div><div class="ttdeci">void write_string(const AnsiString &amp;label, const AnsiString &amp;data)</div><div class="ttdoc">write a string directly to the metadata</div><div class="ttdef"><b>Definition:</b> <a href="_a_p_i_8cpp_source.html#l00032">API.cpp:32</a></div></div>
<div class="ttc" id="aclass_a_p_i_html_abebc08c03ceec2b898d8fe877b0efcba"><div class="ttname"><a href="class_a_p_i.html#abebc08c03ceec2b898d8fe877b0efcba">API::dump</a></div><div class="ttdeci">void dump()</div><div class="ttdoc">save currently recorded status data to INI file</div><div class="ttdef"><b>Definition:</b> <a href="_a_p_i_8cpp_source.html#l00094">API.cpp:94</a></div></div>
<div class="ttc" id="aclass_a_p_i_html_a6d770c4a39e262a9a364a430ac7587f6"><div class="ttname"><a href="class_a_p_i.html#a6d770c4a39e262a9a364a430ac7587f6">API::add_metadata_int</a></div><div class="ttdeci">void add_metadata_int(const AnsiString &amp;label, int *data)</div><div class="ttdoc">add pointer to integer variable to monitor value</div><div class="ttdef"><b>Definition:</b> <a href="_a_p_i_8cpp_source.html#l00028">API.cpp:28</a></div></div>
<div class="ttc" id="aclass_a_p_i_html_a3a2f4241ce0a02bea5b9c5bd4129382e"><div class="ttname"><a href="class_a_p_i.html#a3a2f4241ce0a02bea5b9c5bd4129382e">API::reset_all</a></div><div class="ttdeci">void reset_all()</div><div class="ttdoc">reset all variables</div><div class="ttdef"><b>Definition:</b> <a href="_a_p_i_8cpp_source.html#l00131">API.cpp:131</a></div></div>
<div class="ttc" id="aclass_a_p_i_html_ac531383de112e6ecfe732c72028f31df"><div class="ttname"><a href="class_a_p_i.html#ac531383de112e6ecfe732c72028f31df">API::add_metadata_str</a></div><div class="ttdeci">void add_metadata_str(const AnsiString &amp;label, AnsiString *data)</div><div class="ttdoc">add pointer to string variable to monitor value</div><div class="ttdef"><b>Definition:</b> <a href="_a_p_i_8cpp_source.html#l00020">API.cpp:20</a></div></div>
<div class="ttc" id="aclass_a_p_i_html_aeeef34d89b6e7cb0086e08ab136c43c7"><div class="ttname"><a href="class_a_p_i.html#aeeef34d89b6e7cb0086e08ab136c43c7">API::add_metadata_bool</a></div><div class="ttdeci">void add_metadata_bool(const AnsiString &amp;label, bool *data)</div><div class="ttdoc">add pointer to boolean variable to monitor value</div><div class="ttdef"><b>Definition:</b> <a href="_a_p_i_8cpp_source.html#l00024">API.cpp:24</a></div></div>
<div class="ttc" id="aclass_a_p_i_html"><div class="ttname"><a href="class_a_p_i.html">API</a></div><div class="ttdoc">a class which handles the fetching of information from the ROS interface via pointers to variables of...</div><div class="ttdef"><b>Definition:</b> <a href="_a_p_i_8h_source.html#l00035">API.h:36</a></div></div>
<div class="ttc" id="aclass_a_p_i_html_ade75f7ec04482591f5ec32e1348bfb86"><div class="ttname"><a href="class_a_p_i.html#ade75f7ec04482591f5ec32e1348bfb86">API::train_statuses_</a></div><div class="ttdeci">std::map&lt; AnsiString, AnsiString &gt; train_statuses_</div><div class="ttdef"><b>Definition:</b> <a href="_a_p_i_8h_source.html#l00043">API.h:43</a></div></div>
<div class="ttc" id="aclass_a_p_i_html_a77a81598cc3233ba0a21f98aa29889af"><div class="ttname"><a href="class_a_p_i.html#a77a81598cc3233ba0a21f98aa29889af">API::reset_excludes_</a></div><div class="ttdeci">std::vector&lt; AnsiString &gt; reset_excludes_</div><div class="ttdef"><b>Definition:</b> <a href="_a_p_i_8h_source.html#l00039">API.h:39</a></div></div>
<div class="ttc" id="aclass_a_p_i_html_ab8c8347a7be811af2f0c102c2eb3b236"><div class="ttname"><a href="class_a_p_i.html#ab8c8347a7be811af2f0c102c2eb3b236">API::file_path_</a></div><div class="ttdeci">AnsiString file_path_</div><div class="ttdef"><b>Definition:</b> <a href="_a_p_i_8h_source.html#l00038">API.h:38</a></div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="_a_p_i_8h.html">API.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.18 </li>
  </ul>
</div>
</body>
</html>
